Expand GitHub style references in ChangeLog to URL#1547
Merged
kou merged 3 commits intoruby:masterfrom Jan 15, 2026
Merged
Conversation
nobu
had a problem deploying
to
fork-preview-protection
GitHub Actions
Failure
kou
reviewed
Jan 5, 2026
lib/rdoc/parser/changelog.rb
Outdated
| if base&.match(%r[\A([^:/]+:/+[^/]+/)[^/]+/[^/]+/]) | ||
| repo, host = $&, $1 | ||
| contents = contents.dup | ||
| contents.gsub!(/\b(?:(?i:fix(?:e[sd])?) +)\K#(\d+\b)|\bGH-(\d+)\b|\(\K\#(\d+)(?=\))/) do |
Member
There was a problem hiding this comment.
Could you add a comment with example substitutions for easy to understand? For example:
# base: https://github.com/ruby/ruby/
# Fix #15791 -> [Fix #15791](https://github.com/ruby/ruby/pull/15791)
# ...
lib/rdoc/parser/changelog.rb
Outdated
| if base&.match(%r[\A([^:/]+:/+[^/]+/)[^/]+/[^/]+/]) | ||
| repo, host = $&, $1 | ||
| contents = contents.dup | ||
| contents.gsub!(/\b(?:(?i:fix(?:e[sd])?) +)\K#(\d+\b)|\bGH-(\d+)\b|\(\K\#(\d+)(?=\))/) do |
Member
There was a problem hiding this comment.
Could you unify escape style to \K# or \K\#?
Suggested change
| contents.gsub!(/\b(?:(?i:fix(?:e[sd])?) +)\K#(\d+\b)|\bGH-(\d+)\b|\(\K\#(\d+)(?=\))/) do | |
| contents.gsub!(/\b(?:(?i:fix(?:e[sd])?) +)\K\#(\d+\b)|\bGH-(\d+)\b|\(\K\#(\d+)(?=\))/) do |
lib/rdoc/parser/changelog.rb
Outdated
| repo, host = $&, $1 | ||
| contents = contents.dup | ||
| contents.gsub!(/\b(?:(?i:fix(?:e[sd])?) +)\K#(\d+\b)|\bGH-(\d+)\b|\(\K\#(\d+)(?=\))/) do | ||
| "[#$&](#{repo}pull/#{$1 || $2 || $3})" |
Member
There was a problem hiding this comment.
.../issues/#{N} is better than .../pull/#{N} because .../issues/#{N} works for both of issues and pull requests:
Suggested change
| "[#$&](#{repo}pull/#{$1 || $2 || $3})" | |
| "[#$&](#{repo}issues/#{$1 || $2 || $3})" |
Member
Author
There was a problem hiding this comment.
I think /pull/ also works as well as /issues/, that is the conversion is bidirectional.
Member
Author
There was a problem hiding this comment.
I chose pull just because ruby/ruby is not using GitHub Issues.
lib/rdoc/parser/changelog.rb
Outdated
| repo, host = $&, $1 | ||
| contents = contents.dup | ||
| contents.gsub!(/\b(?:(?i:fix(?:e[sd])?) +)\K#(\d+\b)|\bGH-(\d+)\b|\(\K\#(\d+)(?=\))/) do | ||
| "[#$&](#{repo}pull/#{$1 || $2 || $3})" |
Member
There was a problem hiding this comment.
Could you unify #{...} style?
Suggested change
| "[#$&](#{repo}pull/#{$1 || $2 || $3})" | |
| "[#{$&}](#{repo}pull/#{$1 || $2 || $3})" |
nobu
temporarily deployed
to
fork-preview-protection
GitHub Actions
Inactive
Collaborator
|
🚀 Preview deployment available at: https://51e1142a.rdoc-6cd.pages.dev (commit: 5e609fc) |
kou
reviewed
Jan 8, 2026
| contents.gsub!(/\b(?:(?i:fix(?:e[sd])?) +)\K\#(\d+\b)|\bGH-(\d+)\b|\(\K\#(\d+)(?=\))/) do | ||
| "[#{$&}](#{repo}pull/#{$1 || $2 || $3})" | ||
| end | ||
| contents.gsub!(%r[(?<![-\w#/@]|\]\[)([-\w]+/[-\w]+)(?:@(\h{8,40})|\#(\d+))(?![-\w#/@]|\]\[)]) do |
Member
There was a problem hiding this comment.
Could you add an example comment here too?
nobu
had a problem deploying
to
fork-preview-protection
GitHub Actions
Failure
kou
reviewed
Jan 13, 2026
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
nobu
had a problem deploying
to
fork-preview-protection
GitHub Actions
Failure
nobu
added a commit
to nobu/ruby
that referenced
this pull request
Feb 12, 2026
nobu
added a commit
to nobu/ruby
that referenced
this pull request
Feb 12, 2026
For conciseness, omit URL expansion within ChangeLog files. Instead, RDoc now handles external commit references when converting ChangeLog to HTML. C.f., ruby/rdoc#1547.
paracycle
pushed a commit
to Shopify/ruby
that referenced
this pull request
Feb 15, 2026
For conciseness, omit URL expansion within ChangeLog files. Instead, RDoc now handles external commit references when converting ChangeLog to HTML. C.f., ruby/rdoc#1547.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently, ruby/ruby formats ChangeLog and expands such references to links.
But such links in ChangeLog that is a plain text does not make sense.
I think it is suitable to be done at conversion from ChangeLog to HTML